﻿#region Copyright (c) 2011 R. Uittenbosch
/*
* Copyright (C) 2011 R. Uittenbosch
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
* associated documentation files (the "Software"), to deal in the Software without restriction, including 
* without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
* copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the 
* following conditions:
* 
* The above copyright notice and this permission notice shall be included in all copies or substantial 
* portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
* LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO 
* EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 
* USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#endregion

using System;


namespace DatabaseViewer.Interfaces
{
    public interface IVisualizerNodeFactory
    {
        /// <summary>
        ///  Create a simple node with children having only 1 entry per child
        /// </summary>
        /// <typeparam name="T">The type of object contained in the node</typeparam>
        /// <param name="children">Possible childobjects</param>
        /// <returns>The node just created</returns>        
        IVisualizerNode CreateNode<T>(params IVisualizerNode[] children);

        /// <summary>
        /// Create a node that expects more entries per child
        /// </summary>
        /// <typeparam name="T">The type of object contained in the node</typeparam>
        /// <param name="children">Possible childobjects</param>
        /// <returns>The node just created</returns>    
        IVisualizerNode CreateMultiNode<T>(params IVisualizerNode[] children);

        /// <summary>
        /// Create a simple node with children having only 1 entry per child
        /// </summary>
        /// <typeparam name="T">The type of object contained in the node</typeparam>
        /// <param name="control">The type of control on which to host to node.</param>
        /// <param name="children">Possible childobjects</param>
        /// <returns>The node just created</returns>    
        IVisualizerNode CreateNode<T>( ControlType control, params IVisualizerNode[] children);

        /// <summary>
        /// Create a node that expects more entries per child
        /// </summary>
        /// <typeparam name="T">The type of object contained in the node</typeparam>
        /// <param name="control">The type of control on which to host to node.</param>
        /// <param name="children">Possible childobjects</param>
        /// <returns>The node just created</returns>   
        IVisualizerNode CreateMultiNode<T>(ControlType control, params IVisualizerNode[] children);

        /// <summary>
        /// Create a filter object
        /// </summary>
        /// <returns>An object that can be passed as a filter.</returns>
        IFilter CreateFilter();
    }
}
